Conversation
## Summary Added comprehensive documentation to all scripts across the repository. No functional code was modified — only documentation was added or improved. ### Changes by file - **`bin/checkScripts/downloadCert.js`**: Added JSDoc block for `downloadCert()` with `@async`, `@param`, `@returns`, and `@example` tags. Fixed missing newline at end of file. - **`bin/checkScripts/runDownloadCert.js`**: Added JSDoc blocks for the `OUTPUT_FILE` constant and the IIFE entry point. Fixed missing newline at end of file. - **`cleanup-old-workflows.ps1`**: Added `.SYNOPSIS`, `.DESCRIPTION`, `.EXAMPLE`, and `.NOTES` comment-based help block. - **`create-download-cert.ps1`**: Added full comment-based help describing both generated workflow files (`download-cert.yml` and `powershell-ci.yml`). - **`create-powershell-ci.ps1`**: Added comment-based help detailing the multi-OS CI pipeline it generates. - **`run-workflow-manually.ps1`**: Added comment-based help documenting the GitHub REST API usage, authentication requirements, and interactive prompts. - **`scripts/fetch-profile.ps1`**: Added comment-based help with `.PARAMETER Username` and two `.EXAMPLE` entries. Fixed leading BOM character. Fixed missing newline at end of file. - **`scripts/init.ps1`**: Added comment-based help with startup banner description and example output. Fixed leading BOM character. Fixed missing newline at end of file. - **`scripts/ui_improvements.py`**: Added module-level docstring describing the headless Chrome automation workflow, dependencies, and usage notes. Added inline comments for key steps. - **`start-automation.ps1`**: Added top-level comment-based help describing the two orchestrated components (webhook listener + ngrok). Added inline `.SYNOPSIS`/`.DESCRIPTION` doc blocks for `Start-Listener` and `Start-Ngrok` helper functions. - **`tests/Project.Tests.ps1`**: Added comment-based help summarising both `Describe` blocks. Fixed leading BOM character. - **`webhooks/listener.ps1`**: Added detailed comment-based help covering the request-handling loop, GitHub detection logic, and early-response optimisation rationale. Fixed leading BOM character. Fixed missing newline at end of file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prompt Given
Add or improve documentation for key functions and components.
Summary
Added comprehensive documentation to all scripts across the repository. No functional code was modified — only documentation was added or improved.
Changes by file
bin/checkScripts/downloadCert.js: Added JSDoc block fordownloadCert()with@async,@param,@returns, and@exampletags. Fixed missing newline at end of file.bin/checkScripts/runDownloadCert.js: Added JSDoc blocks for theOUTPUT_FILEconstant and the IIFE entry point. Fixed missing newline at end of file.cleanup-old-workflows.ps1: Added.SYNOPSIS,.DESCRIPTION,.EXAMPLE, and.NOTEScomment-based help block.create-download-cert.ps1: Added full comment-based help describing both generated workflow files (download-cert.ymlandpowershell-ci.yml).create-powershell-ci.ps1: Added comment-based help detailing the multi-OS CI pipeline it generates.run-workflow-manually.ps1: Added comment-based help documenting the GitHub REST API usage, authentication requirements, and interactive prompts.scripts/fetch-profile.ps1: Added comment-based help with.PARAMETER Usernameand two.EXAMPLEentries. Fixed leading BOM character. Fixed missing newline at end of file.scripts/init.ps1: Added comment-based help with startup banner description and example output. Fixed leading BOM character. Fixed missing newline at end of file.scripts/ui_improvements.py: Added module-level docstring describing the headless Chrome automation workflow, dependencies, and usage notes. Added inline comments for key steps.start-automation.ps1: Added top-level comment-based help describing the two orchestrated components (webhook listener + ngrok). Added inline.SYNOPSIS/.DESCRIPTIONdoc blocks forStart-ListenerandStart-Ngrokhelper functions.tests/Project.Tests.ps1: Added comment-based help summarising bothDescribeblocks. Fixed leading BOM character.webhooks/listener.ps1: Added detailed comment-based help covering the request-handling loop, GitHub detection logic, and early-response optimisation rationale. Fixed leading BOM character. Fixed missing newline at end of file.View more about this proposed fix in the CircleCI web app →